home *** CD-ROM | disk | FTP | other *** search
/ CYBER.XPO.95 / CYBER.XPO.95 (Arsenal Computer).ISO / arsenal2 / dosshell / rar1_51.exe / rar / RAR.DOC < prev    next >
Text File  |  1994-06-19  |  36KB  |  1,132 lines
  1.    RAR       multifunctional                     User's manual
  2.              integrated
  3.    v1.51     archive
  4.              manager
  5.  
  6.  
  7.                   Welcome to the RAR Archiver!
  8.  
  9.  
  10.    Introduction
  11.  
  12.    RAR is an extremely powerful tool which allows you manage and 
  13. control archive files.  
  14.  
  15. RAR features include:- 
  16.  
  17. --  Full-screen interactive interface (Optional) included
  18. --  Mouse and menus
  19. --  Non-RAR archive support
  20. --  Common 'standard' command-line interface
  21. --  Highly sophisticated, original compression algorithm
  22. --  Better compression than other PC tools using 'solid' archiving
  23. --  Authenticity verification (registered version)
  24. --  Self-extracting archives, locking, password & more
  25.  
  26.  
  27.    Chapter 1      "Installation and Configuration"
  28.  
  29.    This chapter describes how to install and configure RAR,
  30. as well as giving information on technical requirements.
  31.  
  32.    1.1. Installation procedure
  33.  
  34.    RAR is distributed as a self-extracting (SFX) archive named
  35. RAR?_???.EXE where '?_???' is the version number.
  36.  
  37.    Installation consists of three basic steps:-
  38.  
  39.    ..  Create a directory for the RAR files
  40.  
  41.    ..  Make this directory the current working directory
  42.  
  43.    ..  Execute the RAR Self-Extracting archive
  44.  
  45.  
  46.    For example, on floppy disk A: you have the file
  47. RAR1_51.EXE, this will be RAR version 1.51.  You may install
  48. it to your disk by typing, at the DOS prompt, the following
  49. commands:
  50.  
  51.    C:\> mkdir RAR
  52.    C:\> cd RAR
  53.    C:\RAR>
  54.  
  55.    You have now created a new directory, C:\RAR, and it is
  56. the current working directory.
  57.  
  58.    Then execute RAR self-extracting archive:
  59.  
  60.    C:\RAR> A:RAR1_51
  61.  
  62.    You will be prompted with the RAR archive comment.  Press
  63. any key to continue, or press ESC to cancel the extraction.
  64.  
  65.    When the extraction is successfully completed, a number of
  66. files will be placed in the current directory and RAR will
  67. be ready for use.
  68.  
  69.    The archiver program itself is named RAR.EXE.  This
  70. module contains all of the archiver functionality, packing,
  71. unpacking, repairing, SFX creation etc.
  72.  
  73.    It is recommended that the name of the directory,
  74. containing the RAR files, be added to the PATH environment
  75. variable.  This will enable RAR to be used from any
  76. directory.
  77.  
  78.  
  79.    1.2. Option menu
  80.  
  81.    A number of RAR options may be configured and saved to
  82. be used as default options.  To access this menu, start RAR
  83. without any parameters and then press Function key 9 (F9) to
  84. bring up the Options menu:
  85.  
  86.  
  87.    C:\RAR> RAR
  88.  
  89.    When RAR has been started, press F9 - the following menu
  90. will appear:
  91.  
  92.           ┌─────────────────────────────────┐
  93.           │ Configuration...                │
  94.           │ Set password              ALT-P │
  95.           │ Work directory            ALT-W │
  96.           │ Default comment file            │
  97.           │ External viewer                 │
  98.           │ Change disk               ALT-D │
  99.           │ Registration                    │
  100.           │ Save options              ALT-S │
  101.           └─────────────────────────────────┘
  102.  
  103.    Press <Enter> for the sub-menu "Configuration".  The
  104. configuration menu offers a number of basic options which
  105. may be changed.
  106.  
  107.    In the configuration menu, use the arrow keys to move
  108. from item to item.  An item value may be changed by hitting
  109. the <space> key.  When all items are set as desired, move to
  110. the "Ok" field and hit <Enter> to save the chosen values.
  111. To discard any changes, move to the "Cancel" field and hit
  112. <Enter>.
  113.  
  114.    If you have a mouse attached, this process is even
  115. easier.  Simply move the mouse cursor to the desired item
  116. and click the left mouse key.
  117.    When you've completed the configuration, move the mouse
  118. cursor to the field " Ok " and click on the left mouse key.
  119. To discard changes click the left mouse key on the " Cancel "
  120. field.
  121.  
  122.  
  123.    "Configuration/Interface options"
  124.  
  125.      Color                  Marking this option enables
  126.                             colors in full-screen mode
  127.  
  128.      Mouse                  This enables the use of the
  129.                             mouse in full-screen mode
  130.  
  131.      Sound                  This enables RAR produce sound
  132.                             beeps in different situations
  133.  
  134.      Stdout mode            This forces RAR to run in console
  135.                             (stdout) mode while processing
  136.                             commands from the command line
  137.  
  138.  
  139.    "Configuration/Sort names"
  140.  
  141.    Choose the method used for sorting the archive content
  142. list from one of the following:
  143.  
  144.      Unsorted      Do not sort names
  145.      By name       Sort files by name
  146.      By extension  Sort files by extension
  147.      By size       Sort files by size
  148.  
  149.  
  150.    "Configuration/Include file mask"
  151.  
  152.    Choose the categories of files to be included when adding
  153.  to an archive from the following:
  154.  
  155.      System files       Add files with 'System' attribute
  156.      Hidden files       Add files with 'Hidden' attribute
  157.      Read only files    Add files with 'Read-only' attribute
  158.      Archive files      Add files with 'Archive' attribute
  159.      Empty directories  Add empty directories
  160.  
  161.    For more information on file attributes, please refer to your
  162. DOS manual.
  163.  
  164.  
  165.    "Configuration/Compression"
  166.  
  167.    Choose the default compression level from one of the
  168. following:
  169.  
  170.      Store         Do not compress file when adding to archive
  171.      Fastest       Use fastest method (least compressive)
  172.      Fast          Use fast compression method
  173.      Normal        Use normal (default) compression method
  174.      Good          Use good compression method (more compressive)
  175.      Best          Use best compression method (most compressive)
  176.  
  177.  
  178.    "Configuration/Other options"
  179.  
  180.      Keep backup archive    This forces RAR to save the archive
  181.                             file to *.BAK before it changed
  182.  
  183.      Add empty directories  This enables add empty directories
  184.                             to archive
  185.  
  186.      Put Authenticity       This forces RAR to place
  187.        verification         authenticity verification
  188.                             into archives when they are
  189.                             created. (This feature is only
  190.                             available in the registered
  191.                             version)
  192.  
  193.      Log errors to file     This enables logging critical
  194.                             errors to file RAR.LOG. (This
  195.                             feature is only available in
  196.                             the registered version)
  197.  
  198.    "Set password"
  199.  
  200.    Assign a password which will used when you add/extract files
  201. to/from an archive.  You can define the password using <Alt/P>.
  202. Note, the password will not be saved to the configuration file.
  203.  
  204.  
  205.    "Work directory"
  206.  
  207.    The path where RAR will place temporary files.  This may
  208. be changed at any time by pressing <Alt/W>.
  209.  
  210.  
  211.    "Default comment file"
  212.  
  213.    If you would like a common comment added to every archive you are
  214. creating, enter the full path and name here.
  215.  
  216.  
  217.    "External viewer"
  218.  
  219.    You may assign an external viewer program to run for viewing
  220. file in archives (by pressing <F3>).
  221.  
  222.    RAR stores the default configuration in the file RAR.CFG, which
  223. is held in the same directory as RAR.EXE.
  224.  
  225.  
  226.    "Change disk"
  227.  
  228.    You may change the current disk displayed in the work window.
  229.  
  230.  
  231.    "Registration"
  232.  
  233.    To register one must have a registration code.  This code may
  234. be obtained by sending the completed registration form to your
  235. local registration site or the world-wide distribution center.
  236.  
  237.    You will receive the latest version of RAR in registered form
  238. along with your registration key and will then be able to create
  239. archives containing Authenticity verification.
  240.  
  241.  
  242.    "Save setup"
  243.  
  244.    Pressing <Enter> or clicking the left mouse key on this item
  245. will pop up a small confirmation window in which the user is
  246. invited to " Save " or " Cancel " the saving of the new
  247. configuration for future default usage in RAR.
  248.  
  249.    The configuration may also be saved by pressing ALT-S keys,
  250. pressing the "S" key while simultaneously holding down the "ALT"
  251. key.
  252.  
  253.    These options may also be set by using the left mouse key in the
  254. window "Settings":
  255.  
  256.                    ├────────────── Settings ─────────────╢
  257.                    │   Password                 Absent   ║
  258.                    │   Compression level        Normal   ║
  259.                    │   Archive backup           Disabled ║
  260.                    │   Making AV archives       Enabled  ║
  261.                    │   Log errors to file       Enabled  ║
  262.                    │   Default comment file     Present  ║
  263.                    ┴─────────────────────────────────────╢
  264.  
  265.    For example, click the left mouse key on the word 'Absent' in
  266. the setting 'Password', you will be prompted to enter a new
  267. password.
  268.  
  269.  
  270.    1.3. RAR environment variable
  271.  
  272.    Default parameters may be added to the RAR command line by
  273. establishing an environment variable, using the DOS "SET" command.
  274.  
  275. For example:
  276.  
  277.    C:\> SET RAR=-std -s
  278.  
  279.    RAR will use this string as default parameters in the command
  280. line.
  281.  
  282.    RAR looks firstly to the command line switches, then to the
  283. switches in the environment variable string and finally the options
  284. saved in RAR.CFG.
  285.  
  286.    Switches -sfx, -v, -s, -std from RAR variable have no effect in
  287. full-screen mode.
  288.  
  289.  
  290.    1.4. Technical requirements
  291.  
  292.    Minimum DOS version to run RAR: 3.0
  293.  
  294.    Version specific (for RAR 1.51) conventional memory
  295. requirements:
  296.  
  297.    Starting RAR:                       260 Kb
  298.  
  299.    Extracting and viewing comments:    320 Kb
  300.  
  301.    Creating and updating archives:     420 Kb
  302.  
  303.    Managing non-RAR archives:          260 Kb
  304.  
  305.    (for extraction and updating non-RAR archives add the memory
  306.    requirements of the external archiver)
  307.  
  308.  
  309.    Chapter 2     "Using RAR interactively"
  310.  
  311.    When you execute the command "RAR" at the Dos prompt, you
  312. are presented with the full-screen interface, this is known
  313. as RAR's interactive full-screen mode.
  314.  
  315.    For example, you enter:
  316.  
  317.    C:\> RAR
  318.  
  319.    On the opening screen, right-hand side, you will be
  320. presented with an information box containing the memory
  321. status and settings window.  This information includes:
  322. current compression method, password status (present or
  323. absent), archive back up mode, authenticity verification
  324. status (enabled/disabled), default comment file .. present
  325. or not.
  326.  
  327.    On the left-hand side of the screen are presented a list
  328. of files in the current directory. You can move the cursor
  329. through the files on the screen by using arrow keys or
  330. clicking the left mouse key.
  331.  
  332.    Pressing <Enter> when the cursor is positioned on a
  333. directory, up-directory ("..") or archive file name, will
  334. cause entry to be made to that item.
  335.  
  336.    The following archive types are recognized by RAR: .rar,
  337. .arj .zip, .lzh
  338.  
  339.    Entering an archive, causes the files within the archive
  340. to be displayed in a similar manner as a directory listing.
  341.  
  342.    It is therefore possible to "walk" through directories and
  343. archive files, managing files both in archives and normal
  344. directories.
  345.  
  346.    In "directory" mode, the bottom like of the screen contains
  347. a "menu" of functions provided by the function keys.
  348.  
  349. 1Help 2Add   3View   4Fresh 5Volume 6Move   7Update 8Repair 9Option 0Quit
  350.  
  351.    The line indicates that you may obtain help by pressing
  352. <F1>, add files to an archive by pressing <F2>, view files by
  353. pressing <F3> etc. Press <F10> to quit. These functions are
  354. the main command set when you are in a directory (not in
  355. archive).
  356.  
  357.    Alternatively, pressing and holding down the <ALT> key
  358. will cause the display of additional functions:
  359.  
  360. 1     2Solid 3View.. 4      5SFXVol 6SolVol 7SolSVl 8       9       0
  361.  
  362.    This indicates that Pressing <ALT/F2> can be used to
  363. create a SOLID archive, <ALT/F3> to view an archive using the
  364. internal viewer, etc.
  365.  
  366.    Also shown, by holding down the <ALT> key, will be the
  367. options list:
  368.  
  369.    Alt-J  DOS shell
  370.    Alt-D  Select drive
  371.    Alt-C  Toggle between color and monochrome mode
  372.    Alt-M  Select compression method
  373.    Alt-P  Set password
  374.    Alt-W  Set work directory to store temporary files
  375.    Alt-S  Save setup
  376.  
  377.    Pressing keys, other than those which indicate options and
  378. functions, will put RAR into speed search mode for file names.
  379. This feature can save a lot of keystrokes when looking for
  380. specific file names.
  381.  
  382.    Changing from a directory to an archive will automatically
  383. change the set of available functions to those which are
  384. more suitable to the circumstances.
  385.  
  386.    In "archive" mode the available functions line looks like:
  387.  
  388. 1Help 2Test 3View   4Extr   5Commen 6ExCurD 7SFX   8Delete 9Option 0Quit
  389.  
  390.    This line indicates you can get help pressing <F1>, test
  391. files in archive pressing <F2>, view file by <F3> etc. Press
  392. <F10> to quit. These functions are the main set when you are
  393. in an archive.
  394.  
  395.    Alternatively, when holding down the <Alt> key, the
  396. following would be displayed:
  397.  
  398. 1     2     3View.. 4ExtrTo 5FilCmt 6SolVol 7Lock  8       9       0
  399.  
  400.    Files may be marked/unmarked by using the <Space>, <Ins>,
  401. or right mouse key. You may also mark/unmark file groups by
  402. wildcards (file mask) using the <Gray +> and <Gray -> keys on
  403. the numeric keypad.  Marking a directory, automatically marks
  404. all the sub-directories and files within it.
  405.  
  406.   The marked/unmarked status of a group of files can be
  407. reversed by using the <Gray *> key.  Marking or unmarking a
  408. file, or group of files, updates a highlighted status display
  409. line at the bottom of the screen.  This status line indicates
  410. the number of files marked and the total size in bytes
  411. (the file size of marked directories does not included in the
  412. summary file size).
  413.  
  414.    In full-screen mode, the use of the mouse is fully
  415. supported.  Use the left mouse key to move through a
  416. directory.  Click the left key twice to <Enter>.  Use the
  417. right key to mark files.  When entering text (archive
  418. name, password etc.) the left mouse key cancels the data entry
  419. operation and right mouse key confirms entered text.  Use
  420. the left mouse key to choose function commands (F1-F10) of
  421. menu items and options.
  422.  
  423.    2.1. In a directory
  424.  
  425.      F1       Help information
  426.  
  427.      F2       Add file(s) to an archive, if the archive does
  428.               not exist, it will be created
  429.  
  430.      F3       View a file (if no external viewer is set, the
  431.               internal viewer will be used)
  432.  
  433.      F4       Freshen files in archive - only recently changed files
  434.               will be added instead of their old copies in archive
  435.  
  436.      F5       Create archive volumes (Span diskettes)
  437.  
  438.      F6       Add files not already in the archive and update those
  439.               files changed since they were packed to the archive
  440.  
  441.      F7       Move file(s) to archive
  442.  
  443.      F8       Repair a damaged archive
  444.  
  445.      F9       Set up / Save options
  446.  
  447.      F10      Quit RAR.  Pressing the ESC key has the same
  448.               effect.
  449.  
  450.      Alt-F2   Create a solid archive.
  451.  
  452.      Alt-F3   View file (with internal viewer).
  453.  
  454.      Alt-F5   Create Self-Extracting (SFX) volumes.
  455.  
  456.      Alt-F6   Create solid archive volumes.
  457.  
  458.      Alt-F7   Create solid SFX-volumes.
  459.  
  460.  
  461.    2.1. In an archive
  462.  
  463.    Press <Enter> with the cursor on the archive name to expand
  464. the archive contents.  The same effect may be achieved with
  465. the command-line option "en".   (See Chapter 3, 'en' command)
  466.  
  467.    Once inside an archive, the list of files is displayed on
  468. the left side of the screen.  These files may be marked, just
  469. as files in a directory.
  470.  
  471.    An asterisk (*) to the left of a file name, indicates that
  472. the file is password encrypted.
  473.  
  474.    The right-hand portion of the screen is given over to an
  475. information box, which includes information on:  archive name
  476. and status, comments present/absent, encrypted files, total
  477. number of files in the archive, file sizes, compression ratio,
  478. the minimum RAR version required to extract files and the
  479. host Operating System used to create the archive.
  480.  
  481.    For example:
  482.  
  483.    Info BOX:                Meaning:
  484.  
  485. Archive    EXAMPLE.RAR  - archive name
  486. Archive type    Normal  - not 'solid' archive
  487. Main comment   Present  - archive comment present
  488. File comments   Absent  - no individual file comments
  489. Passwords       Absent  - no password encrypted files
  490. Lock            Absent  - archive not locked
  491. Auth. verif.   Present  - authenticity verification present
  492. Files                1  - number of files (1)
  493. Total length     14917  - total length in bytes
  494. Packed length     3938  - length in archive
  495. Ratio              26%  - compression ratio.  Now 26% of
  496.                           original size.
  497. Version to extr.  1.50  - minimum version required to extract
  498. Host OS            DOS  - OS used to create this archive
  499.  
  500.  
  501.    Function keys actions:
  502.  
  503.      F1       Help information
  504.  
  505.      F2       Test archive (validate integrity)
  506.  
  507.      F3       View a file (if an external viewer is not set,
  508.               the internal viewer will be used)
  509.  
  510.      F4       Extract files from archive with directory
  511.               structure
  512.  
  513.      F5       Add a comment to the archive
  514.  
  515.      F6       Extract file(s) to current directory
  516.  
  517.      F7       Make Self-Extracting (SFX) archive
  518.  
  519.      F8       Delete file(s) from archive
  520.  
  521.      F9       Set up / Save options
  522.  
  523.      F10      Quit RAR
  524.  
  525.      ESC      Return from the archive
  526.  
  527.      Alt-F3   View a file (using the internal viewer)
  528.  
  529.      Alt-F4   Extract file(s) to an alternate path
  530.  
  531.      Alt-F5   Add individual file comment(s)
  532.  
  533.      Alt-F7   Lock the archive preventing modifications
  534.  
  535.  
  536.    When working with archive volumes in full-screen mode you
  537. must begin the process with the first volume, you will be prompted
  538. with a menu:
  539.  
  540.    "Proceed with all volumes from current"
  541.    "Proceed with selected files only"
  542.  
  543.    Choose the method you wish to use to work with the volumes.
  544.  
  545.    When files are displayed which were split between archive
  546. volumes, the compressed size displayed refers to the
  547. compressed size on the current volume.  The symbol ''
  548. indicates that part of the file exists on a previous volume.
  549. The symbol '' indicates that part of the file exist on the
  550. next volume.
  551.  
  552.    Chapter 3    "The RAR command line options"
  553.  
  554.    Command line mode is the opposite of full-screen
  555. interactive mode.  This mode is best used in batch files and
  556. requires no interaction.
  557.  
  558.  
  559.    Usage:
  560.  
  561.  
  562.     RAR <command> -<switch1> -<switchN> <archive> <files...>
  563.         <@listfiles...> <=comment_file> <path_to_extract\>
  564.  
  565.    All parameters must exist on the same, single command line.
  566.  
  567.    command      ..  The function to be performed by RAR, add,
  568.                     extract, move etc.
  569.  
  570.    switch       ..  Switches used to define a specific type of
  571.                     operation, compression strength, type of
  572.                     archive etc.
  573.  
  574.    archive      ..  The name of the archive to be operated upon.
  575.  
  576.    files        ..  The files to be processed.
  577.  
  578.    listfiles    ..  The name of a file containing the names of
  579.                     the files to be operated upon.
  580.  
  581.    comment_file ..  The name of a file containing text to be
  582.                     used as a comment when creating the
  583.                     archive.
  584.  
  585.    path_to_extract  Used only with commands 'e' and 'x',
  586.                     indicating the directory in which to
  587.                     place extracted files.  If this directory
  588.                     does not exist, it will be created.
  589.  
  590.  
  591.    3.1. Commands (Alphabetic sequence)
  592.  
  593. ..  a: add files to archive
  594.  
  595. ..  c: add archive comment
  596.  
  597.        Pressing <F10> will save the entered comment and exit.
  598.     Pressing <Esc> will cancel the comment.  Pressing <F10>
  599.     without entering a comment will remove any existing
  600.     comment.
  601.  
  602.        Comments are displayed while the archive is being
  603.     processed.  The maximum comment length is 16384 bytes.
  604.  
  605.        Support for ANSI esc-sequences is provided in RAR which
  606.     allows the use of colour and cursor movements.  No ANSI
  607.     driver is required to display such comments.
  608.  
  609.       Redefinition of the keyboard using ANSI esc-sequences is
  610.     NOT supported and thus the so-called ANSI-bombs cannot be
  611.     delivered using RAR.
  612.  
  613.     Example:
  614.  
  615.         rar c distrib.rar
  616.  
  617.        Comments may be entered from a file by using the '='
  618.     switch before the name of the file containing the comment.
  619.  
  620.        rar c dummy =info.txt
  621.  
  622. ..  cf: add file comments (not to entire archive)
  623.  
  624.        Pressing <F10> will save the entered comment and exit.
  625.     Pressing <Esc> will cancel the comment.  Pressing <F10>
  626.     without entering a comment will remove any existing
  627.     comment.
  628.  
  629.        Comments are displayed when the 'v' command is given.
  630.     Comment length is limited to 16384 bytes.
  631.  
  632.     Example:
  633.  
  634.        rar cf bigarch *.txt
  635.  
  636. ..  cw: write the archive comment to a file
  637.  
  638.     For example:
  639.  
  640.        rar cw oldarch comment.txt
  641.  
  642.        The comment from the archive oldarch.rar will be
  643.     written to the file comment.txt
  644.  
  645. ..  d: delete files from archive
  646.  
  647. ..  e: extract files from archive to current directory
  648.  
  649. ..  en: start RAR in full-screen mode and enter an archive
  650.  
  651.        Usually this command is included in the extension file
  652.     of a shell processor such as Norton Commander:
  653.  
  654.     RAR: RAR en !.!
  655.  
  656.     Examples:
  657.  
  658.        rar en disk1.rar
  659.  
  660.        rar en puppy.zip
  661.  
  662.        The 'en' may also be omitted, simply start RAR with
  663.     the archive name.
  664.  
  665.     Example:
  666.  
  667.        rar baby.arj
  668.  
  669. ..  f: freshen files in archive
  670.  
  671.        Updates those files changed since they were packed to
  672.     the archive.  This command will not add new files to the
  673.     archive.
  674.  
  675. ..  k: lock archive
  676.  
  677.        Any commands that could change the archive will be
  678.     ignored.
  679.  
  680.     Example:
  681.  
  682.        rar k final.rar
  683.  
  684. ..  l: list archive contents (brief listing)
  685.  
  686.        Files are listed as with the 'v' command with the
  687.     exception of the file path.  i.e. only the file name
  688.     is displayed.
  689.  
  690. ..  m: move files and directories to archive
  691.  
  692.        Moving files and directories results in the files and
  693.     directories being erased upon successful completion of
  694.     the packing operation.  Directories will not be removed
  695.     if '-ed' switch is used.
  696.  
  697. ..  mf: move files to archive
  698.  
  699.         Moving files results in the files being erased upon
  700.     successful completion of the packing operation.
  701.  
  702. ..  p: print file(s) to screen (STDOUT)
  703.  
  704. ..  r: repair damaged archive
  705.  
  706.        RAR cannot restore lost information, so it is not
  707.     possible to recover files which fail the CRC validation,
  708.     but it is possible to recover files which may still exist
  709.     in the archive undamaged.
  710.  
  711.        When this command has completed, a new archive will be
  712.     created, called $RECOVER.RAR
  713.  
  714.        While the recovery process is in operation, RAR will
  715.     prompt the user for assistance when suspicious files are
  716.     located.
  717.  
  718.                       Suspicious entry
  719.  
  720.               Name:  <possibly filename>
  721.               Size:  <size>    Packed: <compressed size>
  722.  
  723.                       Add it: Yes/No/All
  724.  
  725.     Answer 'Y' to add this entry to the file $RECOVER.RAR.
  726.  
  727.     Example:
  728.  
  729.        rar r buggy.rar
  730.  
  731. ..  s: convert archive to a Self-Extracting (SFX) type.
  732.  
  733.        In the Dos environment, this will create a *.EXE file
  734.     which, when executed, will extract the files contained
  735.     within it.
  736.  
  737.        It is also possible to make an SFX archive as the first
  738.     of a multi-volume sequence, but it should be noted that
  739.     the size will be larger by the amount of the SFX-module.
  740.     Please ensure that the first volume in the sequence is
  741.     created with the correct size.  SFX volumes may be created
  742.     using the command 'a' with the switches: '-v[<size>] -sfx'
  743.  
  744.     For example:
  745.  
  746.         rar s diamant
  747.  
  748. ..  t: test archive files
  749.  
  750.        This command performs a dummy file extraction, writing
  751.     nothing to the output stream, in order to validate the
  752.     specified file(s).
  753.  
  754. ..  u: update files in archive
  755.  
  756.        Adds files not already in the archive and updates those
  757.     files changed since they were packed to the archive.
  758.  
  759. ..  v: verbosely list archive content (full listing)
  760.  
  761.        Files are listed using the format: full pathname, file
  762.     comment, original and compressed size, compression ratio,
  763.     last update date and time, attributes, CRC, compression
  764.     method and minimum RAR version required to extract.
  765.  
  766.        To list the contents of all archive volumes, use and
  767.     asterisk (*) in place of the archive file extension.
  768.  
  769.     For example:
  770.  
  771.         rar v multivol.*
  772.  
  773. ..  x: extract files from archive to original (relative)
  774.        directory if pathnames exist in the archive
  775.  
  776. Command limitations:
  777.  
  778.        The commands 'd','u','f' will not operate with archive
  779.     volumes and solid archives.
  780.  
  781.        The command 'a' cannot be used to update an archive
  782.     volume or a solid archives, only to create one.
  783.  
  784.        The commands 'c' and 'cf' will not operate with
  785.     archive volumes, but will work with solid archives.
  786.  
  787.        An archive comment can be added when the archive is
  788.     created using a comment file.
  789.  
  790.  
  791.    3.2. Switches  (Alphabetic sequence)
  792.  
  793. ..  -? display help on commands and switches
  794.  
  795. ..  -av  put authenticity verification (registered versions only!)
  796.  
  797.        RAR will put, in every new and updated archive,
  798.     information concerning the creator, last update time and
  799.     archive name.
  800.  
  801.        If an archive, containing authenticity verification, is
  802.     being modified and this switch is not specified, the
  803.     authenticity verification information will be removed.
  804.  
  805.        When extracting, testing, listing or updating and
  806.     archive with the '-av' switch, RAR will perform integrity
  807.     validation display the message:
  808.  
  809.             Verifying authenticity information ...
  810.  
  811.        In the case of successful authenticity verification, the
  812.     message 'Ok', creator name and last update information
  813.     will be displayed.  In the case of authenticity verification
  814.     failure, the message 'FAILED' will be displayed.
  815.  
  816.        When creating archive volumes with the '-av' switch,
  817.     Cyclic Redundancy Check (CRC) information will be added to
  818.     each volume.
  819.  
  820.        The Authenticity Verification feature, '-av,' is
  821.     recommended for use with archives in a software
  822.     distribution environment.
  823.  
  824.        In order to enable the Authenticity verification feature,
  825.     the program MUST be registered.  Please contact your local
  826.     distribution site or the world-wide distribution center.
  827.  
  828. ..  -b   enable backup archives
  829.  
  830.        This switch will create a backup before an archive is
  831.     modified.  The backup file will have the same name as the
  832.     original archive but with the .BAK extension.  Should this
  833.     file already exist, the backup file will be named with a
  834.     .$BK extension.
  835.  
  836. ..  -bw  black & white (monochrome) mode
  837.  
  838. ..  -c-   disable comments show
  839.  
  840. ..  -cfg- disable read configuration and environment
  841.  
  842. ..  -col colour mode
  843.  
  844. ..  -e<s,h,a,r> set file exclusion attributes
  845.  
  846.        The switches 's', 'h', 'a' or 'r' signify that files
  847.     having the System, Hidden, Archive or Read only attributes
  848.     should be excluded.  The order in which the attributes are
  849.     given is not significant.
  850.  
  851.     Example:
  852.  
  853.        rar a -ehs purity *.exe
  854.  
  855.        Do NOT add files with Hidden or System attributes.
  856.  
  857. ..  -ed  don't add empty directories
  858.  
  859.        This switch indicates that empty directories are not
  860.     to be stored in the created archive.
  861.  
  862. ..  -ep  exclude paths from names
  863.  
  864.        This switch enables files to be added to an archive
  865.     without including the path information.  This could, of
  866.     course, result in multiple files existing in the archive
  867.     with the same name.
  868.  
  869. ..  -ep1 exclude base dir from names
  870.  
  871.        Do not store the path from the command line.
  872.  
  873.        Example:
  874.  
  875.           rar a -ep1 -r pasta tmp\*.*
  876.  
  877.        All files and directories from the directory TMP will
  878.     be added to the archive 'pasta', but the path will not
  879.     include 'TMP\'.  This is equivalent to the commands:
  880.  
  881.          cd tmp
  882.          rar a -ep1 -r pasta
  883.          cd ..
  884.  
  885.        For correct operation of this switch you must use the
  886.     full form of the path, as given in the example above, and
  887.     NOT the command string:  rar a -ep1 -r pasta tmp
  888.  
  889. ..  -f   freshen files
  890.  
  891.        May be used with archive extraction or creation.
  892.  
  893.        The command string "a -f" is equivalent to the command
  894.     'f', you could also use the switch '-f' with the commands
  895.     'm' or 'mf'.  If the switch '-f' is used with the commands
  896.     'x' or 'e', then only old files would be replaced with new
  897.     versions extracted from the archive.
  898.  
  899. ..  -m<0..5> set compression method
  900.  
  901.        -m0   store     do not compress file when adding to
  902.                        archive
  903.        -m1   fastest   use fastest method (less compressive)
  904.        -m2   fast      use fast compression method
  905.        -m3   normal    use normal (default) compression method
  906.        -m4   good      use good compression method (more
  907.                        compressive)
  908.        -m5   best      use best compression method
  909.  
  910.        By default RAR uses -m3 method (Normal compression).
  911.  
  912. ..  -o+ overwrite existing files
  913.  
  914. ..  -o- do not overwrite existing files (default)
  915.  
  916. ..  -p           set password
  917.  
  918.        The password is case-sensitive.  If you omit the
  919.     password on the command line, you will be prompted with:
  920.  
  921.        Enter password:
  922.  
  923.     Example:
  924.  
  925.        rar a -pmyhoney secret *.txt
  926.  
  927.        Newly added files will be encrypted with the password
  928.     'myhoney'.
  929.  
  930. ..  -p<password> set password
  931.  
  932. ..  -r recurse subdirectories
  933.  
  934.        May be used with commands: a,u,f,m,x,e,t,p,v,l,c,cf,s.
  935.  
  936.        When used with the commands 'a', 'u', 'f', 'm' will
  937.     process files in all sub-directories as well as the
  938.     current working directory.
  939.  
  940.        When used with the commands x,e,t,p,v,l,c,cf,s will
  941.     process all archives in sub-directories as well as the
  942.     current working directory.
  943.  
  944. ..  -s   create solid archive
  945.  
  946.        Solid is special archive type.  Please refer to the
  947.     appendix "Glossary" for further information.
  948.  
  949.     Example:
  950.  
  951.        rar a -s -v1440 -sfx maddy *.*
  952.  
  953.        Will create solid Self-Extracting (SFX) volumes of
  954.     size 1440000 bytes.
  955.  
  956. ..  -sfx create Self-Extracting (SFX) archive
  957.  
  958.        If this switch is used when creating a new archive, a
  959.     Self-Extracting archive would be created.
  960.  
  961.     Example:
  962.  
  963.        rar a -sfx sources *.asm
  964.  
  965.        This command would create a Self-Extracting archive
  966.     named SOURCES.EXE.  To extract files from such an archive,
  967.     you would simply execute it.  Self-Extracting archives may
  968.     be processed normally using RAR.
  969.  
  970. ..  -std  stdout mode
  971.  
  972.        All output text is sent to the stdout stream.  This
  973.     allows redirection of RAR output to a file, for example:
  974.  
  975.        rar v -std bambam >bambam.lst
  976.  
  977.     or you could process without any output:
  978.  
  979.        rar x -std dime 10cents.txt >nul
  980.  
  981. ..  -u   update files
  982.  
  983.        May be used with archive extraction or creation.
  984.  
  985.        The command string "a -u" is equivalent to the command
  986.     'u', you could also use the switch '-u' with the commands
  987.     'm' or 'mf'.  If the switch '-u' is used with the commands
  988.     'x' or 'e', then files not present on the disk and files
  989.     newer than their copies on the disk would extracted from
  990.     the archive.
  991.  
  992. ..  -v create volumes with autodetected size
  993.  
  994. ..  -v<size> create archive volumes
  995.  
  996.        By default this switch uses <size> as thousands of
  997.     bytes (not 1024 x bytes).   You may also enter the size in
  998.     kilobytes using the symbol 'k' following the numerical
  999.     value.  If the size is omitted, autodetection will be
  1000.     used.
  1001.  
  1002.        If volumes are created on the same drive as the
  1003.     temporary files (current drive by default, but may be
  1004.     changed with the switch '-w'), the autodetected size
  1005.     becomes meaningless.  In this case the volume size must be
  1006.     explicitly defined.
  1007.  
  1008.        If volumes are created on a drive OTHER than the drive
  1009.     containing the temporary files, then after the first
  1010.     volume has been created, the user will be prompted with:
  1011.  
  1012.            Create next volume: Yes/No/All/Quit
  1013.  
  1014.        At this moment in time, you should change the disks.
  1015.     Answering 'A' will cause all volumes to be created without
  1016.     a pause.
  1017.  
  1018.        The first volume file in a multi-volume set has the
  1019.     extension .RAR, following volumes are numbered from .R00 to
  1020.     .R99.
  1021.  
  1022.        When extracting or testing a multi-volume archive you
  1023.     must use only the first volume name (*.RAR).  If there is
  1024.     no next volume on the drive (and volumes are not placed in
  1025.     the same directory as the temporary files), the user will
  1026.     prompted with:
  1027.  
  1028.            Insert disk with <next volume name>
  1029.  
  1030.        Insert the disk with the correct volume and press any key.
  1031.  
  1032.        If while extracting, the next volume is not found and
  1033.     volumes are placed in the same directory as the temporary
  1034.     files, RAR will abort with the error message:
  1035.  
  1036.            Can't find <volume name>
  1037.            Can't change disk with temporary files
  1038.  
  1039.        Archive volumes may not be modified.  The commands 'd',
  1040.     'f', 'u', 's' can not be used with Multi-volume sets.
  1041.     The command 'a' may be used only for the creation of a
  1042.     new multi-volume sequence.
  1043.  
  1044.        It is possible, although unlikely, that the file size,
  1045.     of a file in a multi-volume set, could be greater than
  1046.     it's uncompressed size.  This is due to the fact that
  1047.     'storing' (no compression if size increases) cannot be
  1048.     enabled for multi-volume sets.
  1049.  
  1050.        Archive volumes may be Self-Extracting (SFX).  Such an
  1051.     archive should be created using both the '-v' and '-sfx'
  1052.     switches.
  1053.  
  1054.  
  1055.     Example:
  1056.  
  1057.     1. Archive drive C: on floppy drive A:
  1058.  
  1059.        rar a -r -v a:allhard c:\*.*
  1060.  
  1061.     (current disk MUST be C:)
  1062.  
  1063.     2. Create archive volumes with 1440000 byte size in current
  1064.        directory.
  1065.  
  1066.        rar a -v1440 4flopp
  1067.  
  1068.     or
  1069.  
  1070.        rar a -v1440 4flopp *.*
  1071.  
  1072. ..  -w<path> assign work directory
  1073.  
  1074.        This switch may be used to assign the directory for
  1075.     temporary files to another drive.  For example a RAM drive
  1076.     or high performance disc.
  1077.  
  1078.        Note, if temporary files cannot be created in the
  1079.     current directory, RAR will search for an available disk
  1080.     automatically.
  1081.  
  1082.     Example:
  1083.  
  1084.        rar a -we:\tmp bmps *.bmp
  1085.  
  1086.        Temporary files would be created in directory E:\TMP
  1087.  
  1088.  
  1089. ..  -x<mask> exclude files specified by mask
  1090.  
  1091.     Example:
  1092.  
  1093.        rar a -x*.bak purearch.rar
  1094.  
  1095. ..  -x@<list> exclude files using specified list file
  1096.  
  1097.     Example:
  1098.  
  1099.        rar a -x@exlist.txt arch *.exe
  1100.  
  1101. ..  -y   assume Yes on all queries
  1102.  
  1103.  
  1104.  
  1105.      Glossary
  1106.  
  1107.  
  1108.    Archive       Special file containing one or more files
  1109.                  optionally encoded and/or compressed.
  1110.  
  1111.    Compression   A method of encoding data to reduce it's
  1112.                  size.
  1113.  
  1114.    CRC           Cyclic Redundancy Check. Mathematic method
  1115.                  calculating special checking information
  1116.                  for data validity.
  1117.  
  1118.    SFX           Archive module used to extract files from
  1119.                  when executed. (SelF-eXtracting module),
  1120.                  usually in the form of a .EXE file.
  1121.  
  1122.    Solid         An archive packed using a special compression
  1123.                  method which sees all files as one continuous
  1124.                  data stream.  Particularly advantageous when
  1125.                  packing a large number of small files.
  1126.  
  1127.    Volume        Part of a split archive. Splitting an archive
  1128.                  to volumes allows storing them on diskettes.
  1129.                  Volumes must be extracted starting from first
  1130.                  in sequence.
  1131.  
  1132.